Skip to content

Update doc#1700

Open
michaelortmann wants to merge 26 commits into
eggheads:developfrom
michaelortmann:doc2
Open

Update doc#1700
michaelortmann wants to merge 26 commits into
eggheads:developfrom
michaelortmann:doc2

Conversation

@michaelortmann
Copy link
Copy Markdown
Member

@michaelortmann michaelortmann commented Oct 16, 2024

Found by: michaelortmann
Patch by: michaelortmann
Fixes:

One-line summary:

Additional description (if needed):

  1. "Last recently changed" lines like the 1st line in ABOUT doc, is often forgotten and looking at our new shiny html version: https://docs.eggheads.org/about/about.html
    it looks like this line doesnt belong there, it should be removed and the page should start with the About headline.
    So this PR removes this cruft above this headline

  2. the sizes of eggdrop install and source tarball have been updated to more likely current values. taken fresh on an x86_64 linux system with du -m.

  3. the rendering of our doc to text files also doesnt work well with lines ending with "-", see:

    v0.7 -v0.9 before finally going 1.0. This version of Eggdrop is part

    v0.7 -v0.9 should be v0.7 - v0.9

  4. this is 1.10 tree, not 1.9:

    of the 1.9 tree. A valiant effort has been made to chase down and

  5. update sphinx_source/_themes/agogo/layout.html
    there was a typo: navigaton
    fixed it by updating 2 strings to the new ones in upstream sphinx 8.0.2:
    https://github.com/sphinx-doc/sphinx/blob/v8.0.2/sphinx/themes/agogo/layout.html

  6. typo fixes.

  7. A feature / usability update of the firststeps doc regarding fingerprint and nickserv magick

  8. do not use public / in use ip addresses and dns names in doc, instead use the ones given by rfc2606, rfc 3849 and rfc 5737

Test cases demonstrating functionality (if applicable):

@michaelortmann
Copy link
Copy Markdown
Member Author

What about removing all "Last revised" lines from docs?

What about updating the whole themes folder in eggdrop to the new sphinx version we use? Or did we customize the that theme?

@michaelortmann michaelortmann force-pushed the doc2 branch 2 times, most recently from d7cdb30 to 7ed5a2a Compare October 16, 2024 13:26
michaelortmann added a commit to michaelortmann/eggdrop that referenced this pull request Oct 21, 2024
@michaelortmann
Copy link
Copy Markdown
Member Author

Found the following grammar glitch:

https://github.com/eggheads/eggdrop/blob/develop/doc/sphinx_source/about/legal.rst?plain=1#L6C165-L7C1

net.c is by Robey has placed it in the public domain.

Comment thread doc/sphinx_source/tutorials/tlssetup.rst
Comment thread doc/sphinx_source/using/botnet.rst Outdated
Comment thread doc/sphinx_source/using/core.rst Outdated
Comment thread eggdrop-basic.conf
@@ -65,7 +65,7 @@ set username "lamest"

## This setting defines which contact person should be shown in .status,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this file to its original state, thanks

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

set admin "Lamer <email: lamer@lamest.lame.org>" < here we use it as default setting, so you are fine with my change here?

Comment thread eggdrop.conf
# /msg help, and other places. You really should include this information.
set admin "Lamer <email: lamer@lamest.lame.org>"
set admin "Lamer <email: lamer@lame.example.org>"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this file to its original state, thanks

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also default setting in config.

Comment thread ssl.conf
#DNS.2 = this.bot.net
#DNS.3 = lamestbot.net
#DNS.2 = example.net
#DNS.3 = example.org
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this file to its original state, thanks

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commented out, but also default setting in config

@vanosg
Copy link
Copy Markdown
Member

vanosg commented Jun 16, 2025

To everything- please revert. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants